package axis

Import Path
	github.com/K-Phoen/grabana/timeseries/axis (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 2 packages

Involved Source Files

	    axis.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Axis (struct)
		Axis represents a visualization axis.

		As Outputs Of (at least one exported)
			func New(fieldConfig *sdk.FieldConfig, options ...Option) (*Axis, error)

	 type Option (func)
		Option represents an option that can be used to configure an axis.

		As Outputs Of (at least 9)
			func Decimals(decimals int) Option
			func Label(label string) Option
			func Max(value float64) Option
			func Min(value float64) Option
			func Placement(placement PlacementMode) Option
			func Scale(mode ScaleMode) Option
			func SoftMax(value int) Option
			func SoftMin(value int) Option
			func Unit(unit string) Option
		As Inputs Of (at least 2)
			func New(fieldConfig *sdk.FieldConfig, options ...Option) (*Axis, error)
			func github.com/K-Phoen/grabana/timeseries.Axis(options ...Option) timeseries.Option

	 type PlacementMode string (basic type)
		PlacementMode represents the axis display placement mode.

		As Inputs Of (at least 2)
			func Placement(placement PlacementMode) Option
			func github.com/K-Phoen/grabana/timeseries/fields.AxisPlacement(placement PlacementMode) fields.OverrideOption
		As Types Of (total 4)
			const Auto
			const Hidden
			const Left
			const Right

	 type ScaleMode uint8 (basic type)
		ScaleMode represents the axis scale distribution.

		As Inputs Of (at least one exported)
			func Scale(mode ScaleMode) Option
		As Types Of (total 3)
			const Linear
			const Log10
			const Log2


Package-Level Functions (total 10)

	 func Decimals(decimals int) Option
		Decimals sets how many decimal points should be displayed.

	 func Label(label string) Option
		Label sets a Y-axis text label.

	 func Max(value float64) Option
		Max defines a hard maximum value for the axis.

	 func Min(value float64) Option
		Min defines a hard minimum value for the axis.

	 func New(fieldConfig *sdk.FieldConfig, options ...Option) (*Axis, error)
		New creates a new Axis configuration.

	 func Placement(placement PlacementMode) Option
		Placement defines how the axis should be placed in the panel.

	 func Scale(mode ScaleMode) Option
		Scale sets the scale to use for the Y-axis values..

	 func SoftMax(value int) Option
		SoftMax defines a soft maximum value for the axis.

	 func SoftMin(value int) Option
		SoftMin defines a soft minimum value for the axis.

	 func Unit(unit string) Option
		Unit sets the unit of the data displayed in this series.


Package-Level Constants (total 7)

	const Auto PlacementMode = "auto"
	const Hidden PlacementMode = "hidden"
	const Left PlacementMode = "left"
	const Linear ScaleMode = 0
	const Log10 ScaleMode = 2
	const Log2 ScaleMode = 1
	const Right PlacementMode = "right"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.